home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1999 #2 / Amiga Plus CD - 1999 - No. 2.iso / System-Boost / Workbench / Reboot / Reboot.doc < prev    next >
Text File  |  1998-06-17  |  10KB  |  268 lines
  1. Reboot/Reboot                                                   Reboot/Reboot
  2.  
  3.     NAME
  4.        Reboot -- rebooting utility
  5.  
  6.     FORMAT
  7.        Reboot [REBOOTDELAY <seconds>] [QUIET|NOREQ] [OFF] [NOGUI]
  8.  
  9.     TEMPLATE
  10.        REBOOTDELAY/K/N,QUIET=NOREQ/S,OFF/S,NOGUI/S
  11.  
  12.     TOOLTYPES
  13.        REBOOTDELAY/N
  14.        QUIET/S
  15.        NOREQ/S
  16.        OFF/S
  17.        NOGUI/S
  18.  
  19.     PURPOSE
  20.        To reboot the computer.
  21.  
  22.     INTRODUCTION
  23.        A simple tool to be used with Kickstart 2.x/3.x, written by
  24.        Roland 'Gizzy' Mainz, freeware, all rights reserved.
  25.        No guarantee of any kind is made that  the programm described below
  26.        in this document is 100% reliable. You use this material on your own
  27.        risk.
  28.  
  29.        While playing with ENVOY 1.6, I need a program which allows to reboot
  30.        another AMIGA through the network (by my own "RemoteNetShell") or
  31.        after a given time.
  32.        First I wrote a little script (using WAIT) and a C program calling
  33.        exec.library/ColdReboot() to solve this problem.
  34.        Switching to IAM's ENVOY 2.0 I replaced this script by this tool,
  35.        adding some features (WB (including multiselect), SHELL ReadArgs,
  36.        locale support and test mode).
  37.  
  38.     DESCRIPTION
  39.        Reboot is used to reboot the whole computer like a "cold"
  40.        system start.
  41.  
  42.        Unless you specify otherwise (through REBOOTDELAY option), reboot
  43.        will wait 2 seconds before rebooting the system.
  44.        This is used to let the system (and it's disk drives) settle.
  45.        This delay time can't be less than 1 second, a REBOOTDELAY=0
  46.        will also wait this minimum time.
  47.  
  48.        Whenever the QUIET (or NOREQ) switch is set, the verify requesters
  49.        ("Are you sure#?" etc.) will be suppressed.
  50.  
  51.        If the OFF switch is set, the tool act like when a CTRL-C signal
  52.        has been send to the tool.
  53.  
  54.        Variable support:
  55.          The environment REBOOT variable (either LOCAL or GLOBAL) can be
  56.          used for default settings. The parsing template for this
  57.          variable is the same like the shell template (see above).
  58.  
  59.        Reboot supports workbench multiselect (e.g. project icons) !
  60.  
  61.        The NOGUI option disables the requester and makes a simple
  62.        console query. Currently, the NOGUI option should not be used
  63.        if launched from WB.
  64.  
  65.        If requesters have been disabled in a shell (using tools like DICE's
  66.        "noreq" tool), the NOGUI option is on per default.
  67.  
  68.     BUGS
  69.        - Shell variables longer than 255 are currently not supported.
  70.  
  71.        - Any errors during tooltype processing are ignored.
  72.  
  73.        - The usage of the NOGUI option is not recommned to be used from
  74.          WB.
  75.  
  76.        - Does not work properly with my Apollo 2030 accerlator board.
  77.          The system reboots, then hangs. Cause known,
  78.          comments welcome.
  79.  
  80.     NOTES
  81.        "Set Reboot OFF" (e.g. use of a local variable) is only valid if
  82.        you start Reboot from this shell.
  83.  
  84.     HISTORY
  85.        V1.1:
  86.          - First release
  87.  
  88.        V1.2:
  89.          - The "Abort reboot" requester couldn't be canceld 1 second before
  90.            the given time.
  91.            Fixed.
  92.  
  93.          - I did not read the autodocs exactly:
  94.            The function BuildEasyRequest might return 0 or 1 at low mem time.
  95.            Now Reboot simply fails with ERROR_NO_FREE_STORE for both 0 or 1.
  96.            If 1 was returned, an enforcer hit would occur.
  97.            Never happed, but
  98.            fixed.
  99.  
  100.          - AttemptOpenLibrary could return (sometimes) random pointers.
  101.            In fact, this never happened by me, but maybe ...
  102.            Fixed.
  103.  
  104.          - While getting Reboot's environment variable, the "Abort reboot"
  105.            requester might be canceled. Now we check this:
  106.            Fixed.
  107.  
  108.          - Additional, there was some code cleanup which adds support for
  109.            DICE INLINE calls.
  110.  
  111.          - The executable is now PURE and can be made resident.
  112.  
  113.          - The time between the program checks the "Abort reboot" requester
  114.            has been decrased down to a half second.
  115.  
  116.        V1.3
  117.          - Starting with V1.3 environment variables are supported.
  118.            Things set in var "REBOOT" (local or global) will be parsed after
  119.            built-in default settings and before any user-given arguments
  120.            (shell args or project icons), which can overide those ENV
  121.            settings given there.
  122.  
  123.            This feature may cause Enforcer hits (I think so, I've never seen
  124.            one).
  125.  
  126.        V1.4
  127.          - Starting with V1.4, ENV parsing should be safe.
  128.            For Bug reports, I've included a Reboot.ld, which includes the
  129.            debugging info used by Enforcer/FindHit.
  130.  
  131.          - Running CPU FASTROM causes sometimes problems: The system reboots,
  132.            but then hang atfer a while... ???
  133.  
  134.        V1.5
  135.          - Now I fully support SAS/C for all my projects (SMakefile
  136.            included). A matching DMakefile is on the way.
  137.  
  138.        V1.6
  139.          - Unused utility.library code has been removed
  140.  
  141.        V1.7
  142.          - Recompiled with SAS/C 6.57
  143.  
  144.          - Minor code cleanup.
  145.  
  146.          - Moved contents of the #?.guide to this autodoc
  147.  
  148.        V1.8
  149.          - Added français catalog file
  150.            Thanks to Julien Wilk (wilkj@esiee.fr).
  151.  
  152.          - Added NOGUI option, e.g. localized console prompt :-)
  153.  
  154.        V1.9
  155.          - Silly mistake: I forgot to update the version string in V1.8.
  156.            (Now the version string shows correctly V1.9).
  157.  
  158.          - Recompiled with SAS/C 6.58 to get rid of some mc68060 problems.
  159.  
  160.          - Fixed the longstanding bug that project icons did only work if
  161.            Reboot's full path was given in "Default Tool".
  162.  
  163.        V1.10
  164.          - Added Croatia (hrvatski) catalog file.
  165.            Thanks to Sinisa Lolic (vegi@usa.net).
  166.  
  167.          - If a (required) shared library  cannot be opened,
  168.            "Reboot" returns now ERROR_INVALID_RESIDENT_LIBRARY instead
  169.            of ERROR_OBJECT_NOT_FOUND.
  170.  
  171.          - The NOGUI option is now on per default if requesters have been
  172.            disabled in the current shell (e..g if (thisproc -> pr_WindowPtr)
  173.            is -1L).
  174.  
  175.          - Added "SmallReboot" project for those people who said that 
  176.            "Reboot" is too big. 
  177.            The small sister of "Reboot" is only ~124 bytes small and still
  178.            includes a version string...
  179.  
  180.  
  181.     INSTALLATION
  182.        After unpacking this archieve:
  183.  
  184.        Workbench:
  185.          - Drop the 'Reboot' icon in your favorite drawer (like
  186.             "SYS:Utilities/").
  187.            See SHELL for copying the catalog files.
  188.  
  189.        Shell:
  190.          - Unpack this archieve at "SYS:Utilities/"
  191.            and add the following statements at your "S:user-startup" startup
  192.            file:
  193.  
  194.            Assign Reboot: SYS:Utilities/Reboot
  195.            path Reboot: ADD
  196.          OR
  197.          - Drop/Copy the 'Reboot' file in your favorite directory
  198.            (like "Sys:Utilities").
  199.            To copy the (german) catalog files, type
  200.            Copy Catalogs/#? TO="LOCALE:Catalogs/" ALL QUIET CLONE
  201.  
  202.        SAS:
  203.          - Type 'smake install' in shell
  204.  
  205.     SOURCE
  206.        DICE users may use DMakefile (if included).
  207.        GNU-C support will be done in one future version.
  208.  
  209.        All:
  210.        If you like to include a new language (like Français or Nederlands
  211.        etc.), send me a filled "Reboot_blank.ct" file named "Reboot_#?.ct"
  212.        (#? for your language). As an example, see "Reboot_deutsch.ct".
  213.        Note that I can currently only process "Reboot_#?.ct" files whose
  214.        language is supported by AmigaOS 3.1 (e.g. a AmigaDOS Locale language
  215.        driver exists).
  216.  
  217.        SAS/C:
  218.        Use SMakefile to create the executable.
  219.        Note that the français locale file cannot be build with SAS/C SMake
  220.        because it does not support the 'ç' character.
  221.  
  222.     AUTHOR's REQUEST
  223.         By  releasing  this program I do  not  place any obligations on you,
  224.         feel free to share this program with your  friends (and enemies).
  225.  
  226.         If you want to blame me, report any bugs, or wants a new version
  227.         send your letter to:
  228.                         Roland Mainz
  229.                         Hohenstaufenstraße 8
  230.                         52388 Nörvenich
  231.                         GERMANY
  232.  
  233.         Phone: (+49)(0)2426/901568
  234.         Fax:   (+49)(0)2426/901569
  235.  
  236.         EMAIL is also available:
  237.         GISBURN@w-specht.rhein-ruhr.de
  238.  
  239.         If you want to send me attachments larger than 1MB (up to 5MB,
  240.         more with my permission):
  241.         Up to August 1998 I'm reachable using this email address, too:
  242.         Reinhold.A.Mainz@KBV.DE
  243.  
  244.         | Please put your name and address in your mails !
  245.         | German mailers should add their phone numbers.
  246.         | See BUGS section above when submitting bug reports.
  247.  
  248.         Sorry, but I can only look once a week for mails.
  249.         If you don't hear something from me within three weeks, please
  250.         send your mail again (but watch about new releases) (problems with
  251.         this email port are caused by reconfigurations, hackers, network
  252.         problems etc.).
  253.  
  254.         The  entire  "Reboot"  package may  be  noncommercially
  255.         redistributed, provided  that  the package  is always  distributed
  256.         in it's complete  form (including it's documentation).  A small copy
  257.         fee for media costs is okay but any kind of commercial distribution
  258.         is strictly forbidden! Comments  and  suggestions  how  to  improve
  259.         this program  are generally appreciated!
  260.  
  261.         Thanks to Matt Dillon for his DICE, and Olaf 'Olsen'
  262.         Barthel for his help, ideas and some text clips from his
  263.         documentations.
  264.  
  265.     SEE ALSO
  266.         exec.library/ColdReboot
  267.  
  268.